<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> *  Permission is hereby granted, free of charge, to any person obtaining<a name="line.4"></a>
<span class="sourceLineNo">005</span> *  a copy of this software and associated documentation files (the<a name="line.5"></a>
<span class="sourceLineNo">006</span> *  "Software"), to deal in the Software without restriction, including<a name="line.6"></a>
<span class="sourceLineNo">007</span> *  without limitation the rights to use, copy, modify, merge, publish,<a name="line.7"></a>
<span class="sourceLineNo">008</span> *  distribute, sublicense, and/or sell copies of the Software, and to<a name="line.8"></a>
<span class="sourceLineNo">009</span> *  permit persons to whom the Software is furnished to do so, subject to<a name="line.9"></a>
<span class="sourceLineNo">010</span> *  the following conditions:<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> *  The above copyright notice and this permission notice shall be<a name="line.12"></a>
<span class="sourceLineNo">013</span> *  included in all copies or substantial portions of the Software.<a name="line.13"></a>
<span class="sourceLineNo">014</span> *<a name="line.14"></a>
<span class="sourceLineNo">015</span> *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,<a name="line.15"></a>
<span class="sourceLineNo">016</span> *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF<a name="line.16"></a>
<span class="sourceLineNo">017</span> *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND<a name="line.17"></a>
<span class="sourceLineNo">018</span> *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<a name="line.18"></a>
<span class="sourceLineNo">019</span> *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<a name="line.19"></a>
<span class="sourceLineNo">020</span> *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION<a name="line.20"></a>
<span class="sourceLineNo">021</span> *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<a name="line.21"></a>
<span class="sourceLineNo">022</span> */<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>package co.aikar.taskchain;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.CompletableFuture;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.function.Consumer;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>@SuppressWarnings("WeakerAccess")<a name="line.29"></a>
<span class="sourceLineNo">030</span>public class TaskChainTasks {<a name="line.30"></a>
<span class="sourceLineNo">031</span>    /**<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * Generic task with synchronous return (but may execute on any thread)<a name="line.32"></a>
<span class="sourceLineNo">033</span>     *<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @param &lt;R&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @param &lt;A&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span>     */<a name="line.36"></a>
<span class="sourceLineNo">037</span>    public interface Task&lt;R, A&gt; {<a name="line.37"></a>
<span class="sourceLineNo">038</span>        /**<a name="line.38"></a>
<span class="sourceLineNo">039</span>         * @see TaskChain#getCurrentChain()<a name="line.39"></a>
<span class="sourceLineNo">040</span>         */<a name="line.40"></a>
<span class="sourceLineNo">041</span>        default TaskChain&lt;?&gt; getCurrentChain() {<a name="line.41"></a>
<span class="sourceLineNo">042</span>            return TaskChain.getCurrentChain();<a name="line.42"></a>
<span class="sourceLineNo">043</span>        }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>        R run(A input);<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * A task that expects no input, and returns a value.<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Likely to be the first task in the chain<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public interface FirstTask&lt;R&gt; extends Task&lt;R, Object&gt; {<a name="line.52"></a>
<span class="sourceLineNo">053</span>        @Override<a name="line.53"></a>
<span class="sourceLineNo">054</span>        default R run(Object input) {<a name="line.54"></a>
<span class="sourceLineNo">055</span>            return run();<a name="line.55"></a>
<span class="sourceLineNo">056</span>        }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>        R run();<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>    /**<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * A task that expects input, but will not provide a response.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * Likely to be the last task in the chain<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param &lt;A&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span>     */<a name="line.66"></a>
<span class="sourceLineNo">067</span>    public interface LastTask&lt;A&gt; extends Task&lt;Object, A&gt; {<a name="line.67"></a>
<span class="sourceLineNo">068</span>        @Override<a name="line.68"></a>
<span class="sourceLineNo">069</span>        default Object run(A input) {<a name="line.69"></a>
<span class="sourceLineNo">070</span>            runLast(input);<a name="line.70"></a>
<span class="sourceLineNo">071</span>            return null;<a name="line.71"></a>
<span class="sourceLineNo">072</span>        }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>        void runLast(A input);<a name="line.74"></a>
<span class="sourceLineNo">075</span>    }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * A task that expects no input or output<a name="line.78"></a>
<span class="sourceLineNo">079</span>     */<a name="line.79"></a>
<span class="sourceLineNo">080</span>    public interface GenericTask extends Task&lt;Object, Object&gt; {<a name="line.80"></a>
<span class="sourceLineNo">081</span>        @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span>        default Object run(Object input) {<a name="line.82"></a>
<span class="sourceLineNo">083</span>            runGeneric();<a name="line.83"></a>
<span class="sourceLineNo">084</span>            return null;<a name="line.84"></a>
<span class="sourceLineNo">085</span>        }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>        void runGeneric();<a name="line.87"></a>
<span class="sourceLineNo">088</span>    }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * A task that returns a future to be completed later. Takes input from chain and when the future completes,<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * the value will be passed to the next task.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     *<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @param &lt;R&gt; The type the Future will complete with<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @param &lt;A&gt; The type from the previous task<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span>    public interface FutureTask&lt;R, A&gt; extends Task&lt;R, A&gt; {<a name="line.97"></a>
<span class="sourceLineNo">098</span>        @Override<a name="line.98"></a>
<span class="sourceLineNo">099</span>        default R run(A input) {<a name="line.99"></a>
<span class="sourceLineNo">100</span>            return null;<a name="line.100"></a>
<span class="sourceLineNo">101</span>        }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>        CompletableFuture&lt;R&gt; runFuture(A input);<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * A Task that returns a future to be completed later. Expects no input, and  when the future completes,<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * the value will be passed to the next task.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     */<a name="line.109"></a>
<span class="sourceLineNo">110</span>    public interface FutureFirstTask&lt;R&gt; extends FutureTask&lt;R, Object&gt; {<a name="line.110"></a>
<span class="sourceLineNo">111</span>        @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span>        default CompletableFuture&lt;R&gt; runFuture(Object input) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>            return runFuture();<a name="line.113"></a>
<span class="sourceLineNo">114</span>        }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>        CompletableFuture&lt;R&gt; runFuture();<a name="line.116"></a>
<span class="sourceLineNo">117</span>    }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * A generic task that expects no input or output, but uses a future style API<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * to control moving to the next task.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     */<a name="line.123"></a>
<span class="sourceLineNo">124</span>    public interface FutureGenericTask extends FutureTask&lt;Object, Object&gt; {<a name="line.124"></a>
<span class="sourceLineNo">125</span>        @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span>        default CompletableFuture&lt;Object&gt; runFuture(Object input) {<a name="line.126"></a>
<span class="sourceLineNo">127</span>            return runFuture();<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>        CompletableFuture&lt;Object&gt; runFuture();<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * A task that does not return immediately. A supplied Consumer controls when<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * the chain should proceed to the next task, and providing a response to be passed<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * to the next task. This is a Callback style API in relation to the Future based API.<a name="line.136"></a>
<span class="sourceLineNo">137</span>     */<a name="line.137"></a>
<span class="sourceLineNo">138</span>    public interface AsyncExecutingTask&lt;R, A&gt; extends Task&lt;R, A&gt; {<a name="line.138"></a>
<span class="sourceLineNo">139</span>        @Override<a name="line.139"></a>
<span class="sourceLineNo">140</span>        default R run(A input) {<a name="line.140"></a>
<span class="sourceLineNo">141</span>            // unused<a name="line.141"></a>
<span class="sourceLineNo">142</span>            return null;<a name="line.142"></a>
<span class="sourceLineNo">143</span>        }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>        void runAsync(A input, Consumer&lt;R&gt; next);<a name="line.145"></a>
<span class="sourceLineNo">146</span>    }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>    /**<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @see AsyncExecutingTask<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * @see FirstTask<a name="line.150"></a>
<span class="sourceLineNo">151</span>     */<a name="line.151"></a>
<span class="sourceLineNo">152</span>    public interface AsyncExecutingFirstTask&lt;R&gt; extends AsyncExecutingTask&lt;R, Object&gt; {<a name="line.152"></a>
<span class="sourceLineNo">153</span>        @Override<a name="line.153"></a>
<span class="sourceLineNo">154</span>        default R run(Object input) {<a name="line.154"></a>
<span class="sourceLineNo">155</span>            // Unused<a name="line.155"></a>
<span class="sourceLineNo">156</span>            return null;<a name="line.156"></a>
<span class="sourceLineNo">157</span>        }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>        @Override<a name="line.159"></a>
<span class="sourceLineNo">160</span>        default void runAsync(Object input, Consumer&lt;R&gt; next) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>            run(next);<a name="line.161"></a>
<span class="sourceLineNo">162</span>        }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>        void run(Consumer&lt;R&gt; next);<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @see AsyncExecutingTask<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * @see GenericTask<a name="line.169"></a>
<span class="sourceLineNo">170</span>     */<a name="line.170"></a>
<span class="sourceLineNo">171</span>    public interface AsyncExecutingGenericTask extends AsyncExecutingTask&lt;Object, Object&gt; {<a name="line.171"></a>
<span class="sourceLineNo">172</span>        @Override<a name="line.172"></a>
<span class="sourceLineNo">173</span>        default Object run(Object input) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>            return null;<a name="line.174"></a>
<span class="sourceLineNo">175</span>        }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span>        @Override<a name="line.177"></a>
<span class="sourceLineNo">178</span>        default void runAsync(Object input, Consumer&lt;Object&gt; next) {<a name="line.178"></a>
<span class="sourceLineNo">179</span>            run(() -&gt; next.accept(null));<a name="line.179"></a>
<span class="sourceLineNo">180</span>        }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span>        void run(Runnable next);<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span>}<a name="line.184"></a>




























































</pre>
</div>
</body>
</html>
